<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<title>SheetBuilder (POI API Documentation)</title>
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
    if (location.href.indexOf('is-external=true') == -1) {
        parent.document.title="SheetBuilder (POI API Documentation)";
    }
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!--   -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!--   -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/SheetBuilder.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/poi/ss/util/RegionUtil.html" title="class in org.apache.poi.ss.util"><span class="strong">PREV CLASS</span></a></li>
<li><a href="../../../../../org/apache/poi/ss/util/SheetReferences.html" title="class in org.apache.poi.ss.util"><span class="strong">NEXT CLASS</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/poi/ss/util/SheetBuilder.html" target="_top">FRAMES</a></li>
<li><a href="SheetBuilder.html" target="_top">NO FRAMES</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_top");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
</div>
<div>
<ul class="subNavList">
<li>SUMMARY:&nbsp;</li>
<li>NESTED&nbsp;|&nbsp;</li>
<li>FIELD&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">CONSTR</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">METHOD</a></li>
</ul>
<ul class="subNavList">
<li>DETAIL:&nbsp;</li>
<li>FIELD&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">CONSTR</a>&nbsp;|&nbsp;</li>
<li><a href="#method_detail">METHOD</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!--   -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<p class="subTitle">org.apache.poi.ss.util</p>
<h2 title="Class SheetBuilder" class="title">Class SheetBuilder</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.poi.ss.util.SheetBuilder</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <strong>SheetBuilder</strong>
extends java.lang.Object</pre>
<div class="block">Class <code>SheetBuilder</code> provides an easy way of building workbook sheets
 from 2D array of Objects. It can be used in test cases to improve code
 readability or in Swing applications with tables.</div>
<dl><dt><span class="strong">Author:</span></dt>
  <dd>Roman Kashitsyn</dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!--   -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../../org/apache/poi/ss/util/SheetBuilder.html#SheetBuilder(org.apache.poi.ss.usermodel.Workbook, java.lang.Object[][])">SheetBuilder</a></strong>(<a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html" title="interface in org.apache.poi.ss.usermodel">Workbook</a>&nbsp;workbook,
            java.lang.Object[][]&nbsp;cells)</code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!--   -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/poi/ss/usermodel/Sheet.html" title="interface in org.apache.poi.ss.usermodel">Sheet</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/ss/util/SheetBuilder.html#build()">build</a></strong>()</code>
<div class="block">Builds sheet from parent workbook and 2D array with cell
 values.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/ss/util/SheetBuilder.html#getCreateEmptyCells()">getCreateEmptyCells</a></strong>()</code>
<div class="block">Returns <code>true</code> if null array elements should be treated as empty
 cells.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/poi/ss/util/SheetBuilder.html" title="class in org.apache.poi.ss.util">SheetBuilder</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/ss/util/SheetBuilder.html#setCreateEmptyCells(boolean)">setCreateEmptyCells</a></strong>(boolean&nbsp;shouldCreateEmptyCells)</code>
<div class="block">Specifies if null array elements should be treated as empty cells.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/poi/ss/util/SheetBuilder.html" title="class in org.apache.poi.ss.util">SheetBuilder</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/ss/util/SheetBuilder.html#setSheetName(java.lang.String)">setSheetName</a></strong>(java.lang.String&nbsp;sheetName)</code>
<div class="block">Specifies name of the sheet to build.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!--   -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!--   -->
</a>
<h3>Constructor Detail</h3>
<a name="SheetBuilder(org.apache.poi.ss.usermodel.Workbook, java.lang.Object[][])">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>SheetBuilder</h4>
<pre>public&nbsp;SheetBuilder(<a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html" title="interface in org.apache.poi.ss.usermodel">Workbook</a>&nbsp;workbook,
            java.lang.Object[][]&nbsp;cells)</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!--   -->
</a>
<h3>Method Detail</h3>
<a name="getCreateEmptyCells()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCreateEmptyCells</h4>
<pre>public&nbsp;boolean&nbsp;getCreateEmptyCells()</pre>
<div class="block">Returns <code>true</code> if null array elements should be treated as empty
 cells.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd><code>true</code> if null objects should be treated as empty cells
         and <code>false</code> otherwise</dd></dl>
</li>
</ul>
<a name="setCreateEmptyCells(boolean)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setCreateEmptyCells</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/poi/ss/util/SheetBuilder.html" title="class in org.apache.poi.ss.util">SheetBuilder</a>&nbsp;setCreateEmptyCells(boolean&nbsp;shouldCreateEmptyCells)</pre>
<div class="block">Specifies if null array elements should be treated as empty cells.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>shouldCreateEmptyCells</code> - <code>true</code> if null array elements should be
                               treated as empty cells</dd>
<dt><span class="strong">Returns:</span></dt><dd><code>this</code></dd></dl>
</li>
</ul>
<a name="setSheetName(java.lang.String)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setSheetName</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/poi/ss/util/SheetBuilder.html" title="class in org.apache.poi.ss.util">SheetBuilder</a>&nbsp;setSheetName(java.lang.String&nbsp;sheetName)</pre>
<div class="block">Specifies name of the sheet to build. If not specified, default name (provided by
 workbook) will be used instead.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>sheetName</code> - sheet name to use</dd>
<dt><span class="strong">Returns:</span></dt><dd><code>this</code></dd></dl>
</li>
</ul>
<a name="build()">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>build</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/poi/ss/usermodel/Sheet.html" title="interface in org.apache.poi.ss.usermodel">Sheet</a>&nbsp;build()</pre>
<div class="block">Builds sheet from parent workbook and 2D array with cell
 values. Creates rows anyway (even if row contains only null
 cells), creates cells if either corresponding array value is not
 null or createEmptyCells property is true.
 The conversion is performed in the following way:
 <p/>
 <ul>
 <li>Numbers become numeric cells.</li>
 <li><code>java.util.Date</code> or <code>java.util.Calendar</code>
 instances become date cells.</li>
 <li>String with leading '=' char become formulas (leading '='
 will be truncated).</li>
 <li>Other objects become strings via <code>Object.toString()</code>
 method call.</li>
 </ul></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>newly created sheet</dd></dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!--   -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!--   -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/SheetBuilder.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/poi/ss/util/RegionUtil.html" title="class in org.apache.poi.ss.util"><span class="strong">PREV CLASS</span></a></li>
<li><a href="../../../../../org/apache/poi/ss/util/SheetReferences.html" title="class in org.apache.poi.ss.util"><span class="strong">NEXT CLASS</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/poi/ss/util/SheetBuilder.html" target="_top">FRAMES</a></li>
<li><a href="SheetBuilder.html" target="_top">NO FRAMES</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_bottom");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
</div>
<div>
<ul class="subNavList">
<li>SUMMARY:&nbsp;</li>
<li>NESTED&nbsp;|&nbsp;</li>
<li>FIELD&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">CONSTR</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">METHOD</a></li>
</ul>
<ul class="subNavList">
<li>DETAIL:&nbsp;</li>
<li>FIELD&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">CONSTR</a>&nbsp;|&nbsp;</li>
<li><a href="#method_detail">METHOD</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!--   -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>
                <i>Copyright 2014 The Apache Software Foundation or
        its licensors, as applicable.</i>
            </small></p>
</body>
</html>
